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

Openapi #1972

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

Openapi #1972

wants to merge 6 commits into from

Conversation

kcirtapfromspace
Copy link
Collaborator

@kcirtapfromspace kcirtapfromspace commented Feb 6, 2024

Note this is not working, thus draft.

Also was trying to get auto generated openapi docs. Though, admittedly i’m not clear on configuring the routes between the frontend & backend.
This is rebased with the docker image caching #1970

Description of change

Looking to add openapi documentation.

  • Serve api documentation on the site
  • Autogenerate docs through tagging

How to test

Issue(s)

Checklists

Every PR

  • Meets issue criteria
  • JIRA ticket status updated
  • Code is meaningfully tested
  • Meets accessibility standards (WCAG 2.1 Levels A, AA)
  • API Documentation updated
  • Boundary diagram updated
  • Logical Data Model updated
  • Architectural Decision Records written for major infrastructure decisions
  • UI review complete

Before merge to main

  • OHS demo complete
  • Ready to create production PR

Production Deploy

  • Staging smoke test completed

After merge/deploy

  • Update JIRA ticket status

Copy link
Collaborator

@GarrettEHill GarrettEHill left a comment

Choose a reason for hiding this comment

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

I am trying to understand what this is all doing, seems like a mix of things

@@ -33,7 +35,7 @@ services:
depends_on:
- minio
clamav-rest:
image: ajilaag/clamav-rest
image: kcirtapfromspace/clamav-rest
Copy link
Collaborator

Choose a reason for hiding this comment

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

I know this is yours, but I see that no one else is maintaining a cross platform version.
I think we need to reconfigure the clamav settings. As the import system is attempting to queue all the files its placing on s3 to be scanned. But they are ~75MB each.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is just to build arm64 on m1 machines. open pr to clam for the to build arm ajilach/clamav-rest#37

Comment on lines +18 to +19
"server": "tsx watch --trace-warnings src/index.ts",
"worker": "tsx watch --trace-warnings src/worker.ts",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Will it get run with this flag in production or just in dev environments?

"docker:dbs:start": "docker-compose -f 'docker-compose.yml' up",
"docker:dbs:stop": "docker-compose -f 'docker-compose.yml' down",
"docker:start": "docker compose up",
"docker:start:debug": "docker compose --compatibility -f docker compose.yml -f docker compose.debug.yml up",
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think you went a little overzealous with ,your find/replace. the filename should still be docker-compose.yml

package.json Show resolved Hide resolved
Copy link
Collaborator Author

@kcirtapfromspace kcirtapfromspace left a comment

Choose a reason for hiding this comment

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

Will it get run with this flag in production or just in dev environments?

This is just to build arm64 on m1 machines. open pr to clam for the to build armhttps://github.com/ajilach/clamav-rest/pull/37

Copy link
Collaborator Author

@kcirtapfromspace kcirtapfromspace left a comment

Choose a reason for hiding this comment

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

Will it get run with this flag in production or just in dev environments?

Probably better to have the conversation on #1970 as that is focused on developer build systems

Copy link
Collaborator Author

@kcirtapfromspace kcirtapfromspace left a comment

Choose a reason for hiding this comment

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

I think you went a little overzealous with ,your find/replace. the filename should still be docker-compose.yml

Probably better to have the conversation on #1970 as that is focused on developer build systems

@thewatermethod
Copy link
Collaborator

Confused about the aim here - we already serve the open API docs as part of the docker container network, is the idea to remove that container and serve them on cloud.gov?

@kcirtapfromspace
Copy link
Collaborator Author

Confused about the aim here - we already serve the open API docs as part of the docker container network, is the idea to remove that container and serve them on cloud.gov?

Yeah, I'm thinking this is a would an easy method that serves load test tools the api docs url. If the docs are auto generated with jsDoc comments we shouldn't have to spell out yaml files.

https://k6.io/blog/load-testing-your-api-with-swagger-openapi-and-k6/

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

Successfully merging this pull request may close these issues.

None yet

3 participants