Skip to content
This repository was archived by the owner on Mar 13, 2025. It is now read-only.

[$100] Swagger Updates #11

Closed
callmekatootie opened this issue Jun 11, 2020 · 6 comments
Closed

[$100] Swagger Updates #11

callmekatootie opened this issue Jun 11, 2020 · 6 comments

Comments

@callmekatootie
Copy link
Collaborator

callmekatootie commented Jun 11, 2020

Skills

  • GET /skills now supports filter by name

Search endpoints

  • New POST /search/users, GET /search/userAttributes, GET /search/userAchievements and GET /search/skills endpoints

/search/users

  • Can be used to search for users that match a criteria
  • Supports pagination through page and perPage query params
  • Support orderBy query param. Values are name, location and isAvailable
  • The request body will contain an object with properties achievements (array of strings), attributes (array of objects with properties id and value, where id is the attribute id), isAvailable (string true or string false), locations (array of strings), organizationId (string) and skills (array of strings)

/search/userAttributes

  • Used to search for a user's attribute values mainly for a lookup
  • attributeId and attributeValue are the query params it supports

/search/userAchievements

  • Used to search for a user's achievement values mainly for a lookup
  • organizationId and keyword (string) are the query params it supports

/search/skills

  • Used to search for skills associated with an org
  • organizationId and keyword are the query params it supports
@callmekatootie
Copy link
Collaborator Author

callmekatootie commented Aug 6, 2020

User Attributes

  • When creating, we need to pass attributeId and value in the request body.

Achievements

  • When creating, we need to pass achievementsProviderId, name, uri, certifierId, certifierDate in the request body.

External Profile

  • When creating, we need to pass organizationId, externalId, uri and isInactive in the request body
  • GET /users/{userId}/externalProfiles now supports filter by externalId and isInactive
  • Update externalProfile model to return externalId, isInactive attribute values too

@callmekatootie
Copy link
Collaborator Author

callmekatootie commented Aug 6, 2020

New OrganizationSkillProvider model

@callmekatootie
Copy link
Collaborator Author

In general, verify that any updates made to GET requests (such as new filters being added) are also copied over to the HEAD requests too

@callmekatootie callmekatootie changed the title TODO: Swagger Updates Swagger Updates Aug 6, 2020
xxcxy added a commit to xxcxy/u-bahn-api that referenced this issue Aug 6, 2020
@callmekatootie callmekatootie changed the title Swagger Updates [$100] Swagger Updates Aug 7, 2020
@cwdcwd
Copy link
Contributor

cwdcwd commented Aug 7, 2020

Contest https://www.topcoder.com/challenges/30136298 has been created for this ticket.

This is an automated message for lazybaer via Topcoder X

@cwdcwd
Copy link
Contributor

cwdcwd commented Aug 7, 2020

Contest https://www.topcoder.com/challenges/30136298 has been updated - it has been assigned to xxcxy.

This is an automated message for lazybaer via Topcoder X

xxcxy added a commit to xxcxy/u-bahn-api that referenced this issue Aug 7, 2020
callmekatootie added a commit that referenced this issue Aug 7, 2020
@cwdcwd
Copy link
Contributor

cwdcwd commented Aug 7, 2020

Payment task has been updated: https://software.topcoder.com/review/actions/ViewProjectDetails?pid=30136298

This is an automated message for lazybaer via Topcoder X

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants