openapi3.yaml

openapi: 3.0.1
info:
  title: Polygon Parts Geoserver API
  description: Unified REST API access to geoserver administration
  version: 2.1.0
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
security: []
paths:
  /workspaces:
    get:
      operationId: getAllWorkspacesNames
      tags:
        - workspaces
      summary: Get list of all workspace names
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspaces'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      operationId: createWorkspace
      tags:
        - workspaces
      summary: create new Workspace object by name
      requestBody:
        description: A json object containing desired workspace name
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
                  description: workspace name
      responses:
        '201':
          description: Created
        '409':
          description: Duplication Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /workspaces/{workspace}:
    get:
      operationId: getWorkspaceIfExist
      tags:
        - workspaces
      summary: Get Workspace object if exist by name or null
      parameters:
        - in: path
          name: workspace
          schema:
            type: string
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      operationId: deleteWorkspace
      tags:
        - workspaces
      summary: delete Workspace by name
      parameters:
        - in: path
          name: workspace
          schema:
            type: string
          required: true
        - in: query
          name: isRecursive
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
              example:
                message: OK
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: Workspace or is not empty
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: No such workspace
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /workspaces/{workspace}/{newWorkspaceName}:
    put:
      operationId: updateWorkspace
      tags:
        - workspaces
      summary: Update Workspace object by name
      parameters:
        - in: path
          name: workspace
          schema:
            type: string
          required: true
        - in: path
          name: newWorkspaceName
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Modified
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: No such workspace
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /dataStores/{workspace}:
    get:
      operationId: getAllDataStores
      tags:
        - dataStores
      summary: gets the workspace's datastores
      parameters:
        - in: path
          name: workspace
          schema:
            type: string
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataStores'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      operationId: createNewDatastore
      tags:
        - dataStores
      summary: create dataStore on provided workspace
      parameters:
        - in: path
          name: workspace
          schema:
            type: string
          required: true
      requestBody:
        description: A json object containing desired data store creation
        required: true
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/DataStoreReq'
      responses:
        '201':
          description: Created
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: No such dataStore
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /dataStores/{workspace}/{dataStore}:
    get:
      operationId: getDataStoreEntity
      tags:
        - dataStores
      summary: gets the dataStore object
      parameters:
        - in: path
          name: workspace
          schema:
            type: string
          required: true
        - in: path
          name: dataStore
          schema:
            type: string
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataStoreInfo'
              example:
                name: Some Example Data Store
                host: http://localhost
                port: 5432
                schema: polygon_parts
                dbName: postgres
                dbType: postgis
                sslMode: DISABLE
                dateCreated: 2024-09-11 06:44:11.551 UTC
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      operationId: updateDataStoreEntity
      tags:
        - dataStores
      summary: update the dataStore object
      parameters:
        - in: path
          name: workspace
          schema:
            type: string
          required: true
        - in: path
          name: dataStore
          schema:
            type: string
          required: true
      requestBody:
        description: A json object containing desired data store creation
        required: true
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/DataStoreReq'
      responses:
        '200':
          description: Modified
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: No such dataStore
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      operationId: deleteDataStoreEntity
      tags:
        - dataStores
      summary: delete the dataStore object
      parameters:
        - in: path
          name: workspace
          schema:
            type: string
          required: true
        - in: path
          name: dataStore
          schema:
            type: string
          required: true
        - in: query
          name: isRecursive
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
              example:
                message: OK
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: 'dataStore is not empty '
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: No such dataStore
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /featureTypes/{workspace}/{dataStore}:
    get:
      operationId: getAllfeatureTypesNames
      tags:
        - featureTypes (Layer publishing)
      summary: Get List of all feature type names
      parameters:
        - in: path
          name: workspace
          schema:
            type: string
          required: true
        - in: path
          name: dataStore
          schema:
            type: string
          required: true
        - in: query
          name: list
          schema:
            type: string
            enum:
              - all
              - configured
              - available
              - available_with_geom
            default: all
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/NameLinkResponse'
                  - $ref: '#/components/schemas/NameResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      operationId: createFeatureType
      tags:
        - featureTypes (Layer publishing)
      summary: Publish new feature
      requestBody:
        description: A json object containing desired details to update on layer
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeatureType'
      parameters:
        - in: path
          name: workspace
          schema:
            type: string
          required: true
        - in: path
          name: dataStore
          schema:
            type: string
          required: true
      responses:
        '201':
          description: Created
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Unprocessable Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /featureTypes/{workspace}/{dataStore}/{featureType}:
    get:
      operationId: getFeatureTypeDetails
      tags:
        - featureTypes (Layer publishing)
      summary: Get List of all feature type names
      parameters:
        - in: path
          name: workspace
          schema:
            type: string
          required: true
        - in: path
          name: dataStore
          schema:
            type: string
          required: true
        - in: path
          name: featureType
          schema:
            type: string
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureTypeInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      operationId: deleteFeatureType
      tags:
        - featureTypes (Layer publishing)
      summary: delete feature type
      parameters:
        - in: path
          name: featureType
          schema:
            type: string
          required: true
        - in: path
          name: workspace
          schema:
            type: string
          required: true
        - in: path
          name: dataStore
          schema:
            type: string
          required: true
        - in: query
          name: isRecursive
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
              example:
                message: OK
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /services/wfs/settings:
    get:
      operationId: getWfsSettings
      tags:
        - WfsSettings
      summary: Get Current Wfs Settings
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WfsSettings'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      operationId: updateWfsSettings
      tags:
        - WfsSettings
      summary: Update Wfs Settings
      requestBody:
        description: Update Wfs Settings
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WfsSettings'
      responses:
        '200':
          description: Modified
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Workspaces:
      type: array
      items:
        $ref: '#/components/schemas/Workspace'
    Workspace:
      type: object
      properties:
        name:
          type: string
        link:
          type: string
    WorkspaceInfo:
      type: object
      properties:
        name:
          type: string
        dateCreated:
          type: string
    DataStores:
      type: array
      items:
        $ref: '#/components/schemas/DataStore'
    DataStore:
      type: object
      properties:
        name:
          type: string
        link:
          type: string
    DataStoreInfo:
      type: object
      properties:
        name:
          type: string
        dateCreated:
          type: string
        host:
          type: string
        port:
          type: number
        schema:
          type: string
        dbType:
          type: string
          enum:
            - postgis
        dbName:
          type: string
        sslMode:
          type: string
          enum:
            - DISABLE
            - ALLOW
            - PREFER
            - REQUIRE
            - VERIFY_CA
            - VERIFY_FULL
    DataStoreReq:
      type: object
      required:
        - name
      properties:
        name:
          type: string
    FeatureType:
      type: object
      required:
        - nativeName
      properties:
        name:
          type: string
        nativeName:
          type: string
    FeatureTypeInfo:
      type: object
      properties:
        name:
          type: string
        tableName:
          type: string
        enabled:
          type: boolean
        srs:
          type: string
        maxFeatures:
          type: number
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/attribute'
    attribute:
      type: object
      properties:
        name:
          type: string
        minOccurs:
          type: number
        maxOccurs:
          type: number
        nillable:
          type: boolean
        binding:
          type: string
        source:
          type: string
    NameLinkResponse:
      type: array
      items:
        type: object
        properties:
          name:
            type: string
          link:
            type: string
        required:
          - name
          - link
    NameResponse:
      type: array
      items:
        type: object
        properties:
          name:
            type: string
        required:
          - name
    WfsSettings:
      type: object
      properties:
        serviceLevel:
          type: string
          enum:
            - BASIC
            - TRANSACTIONAL
            - COMPLETE
        maxFeatures:
          type: number
    Error:
      type: object
      required:
        - message
      properties:
        message:
          type: string