Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

B 19181 create pptas api #12622

Draft
wants to merge 26 commits into
base: main
Choose a base branch
from
Draft

B 19181 create pptas api #12622

wants to merge 26 commits into from

Conversation

joeydoyecaci
Copy link
Contributor

@joeydoyecaci joeydoyecaci commented May 8, 2024

Linked BLI: B-19181
Linked Integration PR: B 19181 int create pptas api
##How to test:

#Testing Prerequisites

  1. Postman is required to test.
  2. PPTAS is acessed through TLS similar to acessing Prime API. In setup of Postman, you must add the mTLS certificates to postman. See Setup Postman to make mTLS calls. This will cover your authentication to the API.
  3. Easiest way to get the API definition into postman is to import it as a Postman collection with OpenAI Spec 2.0 using the generated pptas.yaml file under /swagger.
  4. Setup an environment in postman for making Prime API calls, then set an env variable for the base url and api (Optional, but otherwise you will have to manually add base url to the request). EnvSetup
  5. Setup a collection variable for the path routing from base url to api path (prime/pptas). Set apiPath under collection variables as shown here:
    CollectionVariableSettings
  6. Click on listMoves to edit the request to the following: {{baseUrl}}/{{apiPath}}/moves?since=<dateTime>
    RouteSetup
    7, Both client and server must be running.

#How To Test

  1. Go to PPTAS Swagger and verify that the page loads and there is a single endpoint here.
    PPTAS SwaggerScreenshot

  2. Go under that endpoint and try calling it using the example date (or any date).
    PPTAS moves

  3. The page should show the JSON results under a 200 result.

  4. Within postman run the request using the one you setup in the pre requisites earlier. This should return a 200 result the reuslts in the response body.
    PPTASRequestPostman

rAuth.Use(middleware.NoCache())
rAuth.Mount("/", pptasapi.NewPPTASApiHandler(routingConfig.HandlerConfig))
})
})
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

only difference in the main/int branches is some changes coming from another branch during a merge. Looks good!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants