diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 2b7020d..12914bc 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -18,10 +18,6 @@ tags: description: "Users registered in the system" - name: "Users Skills" description: "Skills of users" -- name: "Skills" - description: "Skills registered in the system" -- name: "Skills Provider" - description: "Skill providers registered in the system" - name: "Roles" description: "Roles registered in the system" - name: "User Roles" @@ -815,558 +811,6 @@ paths: security: - Bearer: [] x-swagger-router-controller: "UsersSkills" - /skills: - get: - tags: - - "Skills" - description: "Get list of skills in the application. If no results, then empty\ - \ array is returned. Multiple filters are\nsupported.\n\n**Security** - Note\ - \ that for non-admin users, this endpoint will only return entities that\n\ - the user has created.\n" - operationId: "skillsGET" - parameters: - - $ref: '#/parameters/page' - - $ref: '#/parameters/perPage' - - name: "skillProviderId" - in: "query" - description: "The referenced skill provider id" - type: "string" - format: "UUID" - - name: "externalId" - in: "query" - description: "The external id of the skill" - type: "string" - - name: "name" - in: "query" - description: "The name of the skill" - type: "string" - - name: "orderBy" - in: "query" - type: "string" - description: "Specify by which field to sort by. Sorts in ascending order only" - responses: - "200": - description: "OK - the request was successful" - schema: - type: "array" - items: - $ref: "#/definitions/Skill" - headers: - X-Next-Page: - type: integer - description: The index of the next page - X-Page: - type: integer - description: The index of the current page (starting at 1) - X-Per-Page: - type: integer - description: The number of items to list per page - X-Prev-Page: - type: integer - description: The index of the previous page - X-Total: - type: integer - description: The total number of items - X-Total-Pages: - type: integer - description: The total number of pages - Link: - type: string - description: Pagination link header. - "400": - $ref: "#/definitions/BadRequest" - "401": - $ref: "#/definitions/Unauthorized" - "403": - $ref: "#/definitions/Forbidden" - "500": - $ref: "#/definitions/ServerError" - security: - - Bearer: [] - x-swagger-router-controller: "Skills" - head: - tags: - - "Skills" - description: "Retrieve header information for get operation on Skills in the\ - \ application.\n\n**Security** - Note that for non-admin users, this endpoint\ - \ will only return entities that\nthe user has created.\n" - operationId: "skillsHEAD" - parameters: - - $ref: '#/parameters/page' - - $ref: '#/parameters/perPage' - - name: "skillProviderId" - in: "query" - description: "The referenced skill provider id" - type: "string" - format: "UUID" - - name: "externalId" - in: "query" - description: "The external id of the skill" - type: "string" - responses: - "200": - description: "Success response" - headers: - X-Next-Page: - type: integer - description: The index of the next page - X-Page: - type: integer - description: The index of the current page (starting at 1) - X-Per-Page: - type: integer - description: The number of items to list per page - X-Prev-Page: - type: integer - description: The index of the previous page - X-Total: - type: integer - description: The total number of items - X-Total-Pages: - type: integer - description: The total number of pages - Link: - type: string - description: Pagination link header. - "400": - $ref: "#/definitions/BadRequest" - "401": - $ref: "#/definitions/Unauthorized" - "403": - $ref: "#/definitions/Forbidden" - "500": - $ref: "#/definitions/ServerError" - security: - - Bearer: [] - x-swagger-router-controller: "Skills" - post: - tags: - - "Skills" - description: "Create a new Skill.\n\n**Security** - This endpoint is accessible\ - \ by all authenticated users. \n" - operationId: "skillsPOST" - parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/SkillRequestBody" - responses: - "200": - description: "OK - the request was successful" - schema: - $ref: "#/definitions/Skill" - "400": - $ref: "#/definitions/BadRequest" - "401": - $ref: "#/definitions/Unauthorized" - "403": - $ref: "#/definitions/Forbidden" - "409": - $ref: "#/definitions/Conflict" - "500": - $ref: "#/definitions/ServerError" - security: - - Bearer: [] - x-swagger-router-controller: "Skills" - /skills/{skillId}: - get: - tags: - - "Skills" - description: "Get Skill by given skill id.\n\n**Security** - Note that for non-admin\ - \ users, this endpoint will only return entities that\nthe user has created.\ - \ \n" - operationId: "skillsSkillIdGET" - parameters: - - name: "skillId" - in: "path" - description: "The skill id" - required: true - type: "string" - format: "UUID" - responses: - "200": - description: "OK - the request was successful" - schema: - $ref: "#/definitions/Skill" - "400": - $ref: "#/definitions/BadRequest" - "401": - $ref: "#/definitions/Unauthorized" - "403": - $ref: "#/definitions/Forbidden" - "404": - $ref: "#/definitions/NotFound" - "500": - $ref: "#/definitions/ServerError" - security: - - Bearer: [] - x-swagger-router-controller: "Skills" - head: - tags: - - "Skills" - description: "Retrieve header information for get operation on Skill by its\ - \ Id in the application.\n\n**Security** - Note that for non-admin users,\ - \ this endpoint will only return entities that\nthe user has created. \ - \ \n" - operationId: "skillsSkillIdHEAD" - parameters: - - name: "skillId" - in: "path" - description: "The user id" - required: true - type: "string" - format: "UUID" - responses: - "200": - description: "OK - the request was successful" - "400": - $ref: "#/definitions/BadRequest" - "401": - $ref: "#/definitions/Unauthorized" - "403": - $ref: "#/definitions/Forbidden" - "404": - $ref: "#/definitions/NotFound" - "500": - $ref: "#/definitions/ServerError" - security: - - Bearer: [] - x-swagger-router-controller: "Skills" - delete: - tags: - - "Skills" - description: "Remove an existing skill with given id.\n\n**Security** - Note\ - \ that this endpoint is only available for admin users. \n" - operationId: "skillsSkillIdDELETE" - parameters: - - name: "skillId" - in: "path" - description: "The skill id" - required: true - type: "string" - format: "UUID" - responses: - "204": - description: "OK - the request was successful" - "401": - $ref: "#/definitions/Unauthorized" - "403": - $ref: "#/definitions/Forbidden" - "404": - $ref: "#/definitions/NotFound" - "409": - $ref: "#/definitions/Conflict" - "500": - $ref: "#/definitions/ServerError" - security: - - Bearer: [] - x-swagger-router-controller: "Skills" - patch: - tags: - - "Skills" - description: "Update an existing skill with given id.\n\n**Security** - Note\ - \ that for non-admin users, this endpoint will only allow updates on entities\ - \ that the\ncalling user has created.\n" - operationId: "skillsSkillIdPATCH" - parameters: - - name: "skillId" - in: "path" - description: "The skill id" - required: true - type: "string" - format: "UUID" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/SkillUpdateRequestBody" - responses: - "200": - description: "OK - the request was successful" - schema: - $ref: "#/definitions/Skill" - "400": - $ref: "#/definitions/BadRequest" - "401": - $ref: "#/definitions/Unauthorized" - "403": - $ref: "#/definitions/Forbidden" - "404": - $ref: "#/definitions/NotFound" - "409": - $ref: "#/definitions/Conflict" - "500": - $ref: "#/definitions/ServerError" - security: - - Bearer: [] - x-swagger-router-controller: "Skills" - /skillsProviders: - get: - tags: - - "Skills Provider" - description: "Search Skills Provider in the application. If no results, then\ - \ empty array is returned.\n\n**Security** - Note that for non-admin users,\ - \ this endpoint will only return entities that\nthe user has created.\n" - operationId: "skillsProvidersGET" - parameters: - - $ref: '#/parameters/page' - - $ref: '#/parameters/perPage' - - name: "name" - in: "query" - description: "Filter by provider name" - required: false - type: "string" - responses: - "200": - description: "OK - the request was successful" - schema: - type: "array" - items: - $ref: "#/definitions/SkillsProvider" - headers: - X-Next-Page: - type: integer - description: The index of the next page - X-Page: - type: integer - description: The index of the current page (starting at 1) - X-Per-Page: - type: integer - description: The number of items to list per page - X-Prev-Page: - type: integer - description: The index of the previous page - X-Total: - type: integer - description: The total number of items - X-Total-Pages: - type: integer - description: The total number of pages - Link: - type: string - description: Pagination link header. - "400": - $ref: "#/definitions/BadRequest" - "401": - $ref: "#/definitions/Unauthorized" - "403": - $ref: "#/definitions/Forbidden" - "500": - $ref: "#/definitions/ServerError" - security: - - Bearer: [] - x-swagger-router-controller: "SkillsProvider" - head: - tags: - - "Skills Provider" - description: "Retrieve header information for a search operation on skills providers\ - \ in the application.\n\n**Security** - Note that for non-admin users, this\ - \ endpoint will only return entities that\nthe user has created.\n" - operationId: "skillsProvidersHEAD" - parameters: - - name: "name" - in: "query" - description: "Filter by provider name" - required: false - type: "string" - responses: - "200": - description: "Success response" - headers: - X-Next-Page: - type: integer - description: The index of the next page - X-Page: - type: integer - description: The index of the current page (starting at 1) - X-Per-Page: - type: integer - description: The number of items to list per page - X-Prev-Page: - type: integer - description: The index of the previous page - X-Total: - type: integer - description: The total number of items - X-Total-Pages: - type: integer - description: The total number of pages - Link: - type: string - description: Pagination link header. - "400": - $ref: "#/definitions/BadRequest" - "401": - $ref: "#/definitions/Unauthorized" - "403": - $ref: "#/definitions/Forbidden" - "500": - $ref: "#/definitions/ServerError" - security: - - Bearer: [] - x-swagger-router-controller: "SkillsProvider" - post: - tags: - - "Skills Provider" - description: "Create a new Skills Provider.\n\n**Security** - This endpoint\ - \ is accessible by all authenticated users. \n" - operationId: "skillsProvidersPOST" - parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/NameRequestBody" - responses: - "200": - description: "OK - the request was successful" - schema: - $ref: "#/definitions/SkillsProvider" - "400": - $ref: "#/definitions/BadRequest" - "401": - $ref: "#/definitions/Unauthorized" - "403": - $ref: "#/definitions/Forbidden" - "409": - $ref: "#/definitions/Conflict" - "500": - $ref: "#/definitions/ServerError" - security: - - Bearer: [] - x-swagger-router-controller: "SkillsProvider" - /skillsProviders/{providerId}: - get: - tags: - - "Skills Provider" - description: "Get skills provider with given id.\n\n**Security** - Note that\ - \ for non-admin users, this endpoint will only return entities that\nthe user\ - \ has created. \n" - operationId: "skillsProvidersProviderIdGET" - parameters: - - name: "providerId" - in: "path" - description: "The provider id" - required: true - type: "string" - format: "UUID" - responses: - "200": - description: "OK - the request was successful" - schema: - $ref: "#/definitions/SkillsProvider" - "400": - $ref: "#/definitions/BadRequest" - "401": - $ref: "#/definitions/Unauthorized" - "403": - $ref: "#/definitions/Forbidden" - "404": - $ref: "#/definitions/NotFound" - "500": - $ref: "#/definitions/ServerError" - security: - - Bearer: [] - x-swagger-router-controller: "SkillsProvider" - head: - tags: - - "Skills Provider" - description: "Get skills provider with given id, but only header information\ - \ is returned.\n\n**Security** - Note that for non-admin users, this endpoint\ - \ will only return entities that\nthe user has created. \n" - operationId: "skillsProvidersProviderIdHEAD" - parameters: - - name: "providerId" - in: "path" - description: "The provider id" - required: true - type: "string" - format: "UUID" - responses: - "200": - description: "OK - the request was successful" - "400": - $ref: "#/definitions/BadRequest" - "401": - $ref: "#/definitions/Unauthorized" - "403": - $ref: "#/definitions/Forbidden" - "404": - $ref: "#/definitions/NotFound" - "500": - $ref: "#/definitions/ServerError" - security: - - Bearer: [] - x-swagger-router-controller: "SkillsProvider" - delete: - tags: - - "Skills Provider" - description: "Remove an existing skills provider with given id.\n\n**Security**\ - \ - Note that this endpoint is only available for admin users. \n" - operationId: "skillsProvidersProviderIdDELETE" - parameters: - - name: "providerId" - in: "path" - description: "The provider id" - required: true - type: "string" - format: "UUID" - responses: - "204": - description: "OK - the request was successful" - "401": - $ref: "#/definitions/Unauthorized" - "403": - $ref: "#/definitions/Forbidden" - "404": - $ref: "#/definitions/NotFound" - "409": - $ref: "#/definitions/Conflict" - "500": - $ref: "#/definitions/ServerError" - security: - - Bearer: [] - x-swagger-router-controller: "SkillsProvider" - patch: - tags: - - "Skills Provider" - description: "Update an existing skills provider with given id.\n\n**Security**\ - \ - Note that for non-admin users, this endpoint will only allow updates on\ - \ entities that the\ncalling user has created.\n" - operationId: "skillsProvidersProviderIdPATCH" - parameters: - - name: "providerId" - in: "path" - description: "The provider id" - required: true - type: "string" - format: "UUID" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/NameRequestBody" - responses: - "200": - description: "OK - the request was successful" - schema: - $ref: "#/definitions/SkillsProvider" - "400": - $ref: "#/definitions/BadRequest" - "401": - $ref: "#/definitions/Unauthorized" - "403": - $ref: "#/definitions/Forbidden" - "404": - $ref: "#/definitions/NotFound" - "409": - $ref: "#/definitions/Conflict" - "500": - $ref: "#/definitions/ServerError" - security: - - Bearer: [] - x-swagger-router-controller: "SkillsProvider" /roles: get: tags: @@ -4618,34 +4062,6 @@ definitions: type: "string" description: "The name of the provider." - $ref: "#/definitions/AuditFields" - Skill: - allOf: - - type: "object" - required: - - "externalId" - - "id" - - "name" - - "skillProviderId" - - "uri" - properties: - id: - type: "string" - format: "UUID" - description: "The skill id" - skillProviderId: - type: "string" - format: "UUID" - description: "The referenced skill provider id" - name: - type: "string" - description: "The name of the skill" - externalId: - type: "string" - description: "The external id for the skill" - uri: - type: "string" - description: "The uri for the skill" - - $ref: "#/definitions/AuditFields" LookupSkill: allOf: - type: "object" @@ -4661,46 +4077,6 @@ definitions: name: type: "string" description: "The name of the skill" - SkillRequestBody: - allOf: - - type: "object" - - $ref: "#/definitions/SkillUpdateRequestBody" - SkillUpdateRequestBody: - type: "object" - properties: - skillProviderId: - type: "string" - format: "UUID" - description: "The id of provider for this Skill." - name: - type: "string" - description: "Name of Skill" - uri: - type: "string" - description: "Uri of Skill" - externalId: - type: "string" - description: "External Id of skill" - example: - skillProviderId: "skillProviderId" - name: "name" - externalId: "externalId" - uri: "uri" - SkillsProvider: - allOf: - - type: "object" - required: - - "id" - - "name" - properties: - id: - type: "string" - format: "UUID" - description: "The id of the provider." - name: - type: "string" - description: "The name of the provider." - - $ref: "#/definitions/AuditFields" ExternalProfile: allOf: - type: "object"