GSA / ITDB-schema

IT Dashboard submissions schema, documentation and example files.
18 stars 24 forks source link

[IT Collect] multiple schemas per "tag" #459

Open KellyHarrisT opened 2 years ago

KellyHarrisT commented 2 years ago

in the Components there are multiple schemas for each Tag (see below an example for Services). Is there an explanation how each one is used? An example of where this is confusing, for postServicesCollection the request body says to use Services.jsonld-write_create / Services-write_create. Neither of these allow for a "Created" or "CreatedBy" to be passed (matches the Service+Post, https://gsa.github.io/ITDB-schema/#operation/postServicesCollection). When I "Get" the service, there are values in the "createdBy" matching my name. That seems to be a bad idea, since it was created by someone else. Shoudn't the creation date match when the user created it and not when it was added to GSA?

Services Services-readItem_readItemSubRes_supService Services-read_create Services-read_supService Services-write Services-write_create Services.jsonld Services.jsonld-readItem_readItemSubRes_supService Services.jsonld-read_create Services.jsonld-read_supService Services.jsonld-write Services.jsonld-write_create

lschwenkebah commented 2 years ago

Hi Kelly,

Thanks for reaching out. Created and CreatedByare standard system generated stamp-able trait fields. These fields are generated by IT Collect to monitor who has created an individual record and when that record was created on IT Collect. Users are not able to overwrite these system generated fields. Please note the lastModified and lastModifiedBy fields fall under the same category.

Right now, there are no fields in the BY 2023 Submission Overview that ask agencies to provide the PM or other agency user creates/manages an investment.

Best, Luke ITDB Support

KellyHarrisT commented 2 years ago

Thank You Luke for the response and clarification.

How about these Component.schemas for Service? Is there an explanation how each one is used?

Services Services-readItem_readItemSubRes_supService Services-read_create Services-read_supService Services-write Services-write_create Services.jsonld Services.jsonld-readItem_readItemSubRes_supService Services.jsonld-read_create Services.jsonld-read_supService Services.jsonld-write Services.jsonld-write_create

From: Luke Schwenke @.> Sent: Friday, August 27, 2021 11:30 AM To: GSA/ITDB-schema @.> Cc: Harris, Kelly @.>; Author @.> Subject: Re: [GSA/ITDB-schema] [IT Collect] multiple schemas per "tag" (#459)

Caution: External email. Pay attention to suspicious links and attachments. Send suspicious email to **@.*

Hi Kelly,

Thanks for reaching out. Created and CreatedBy are standard system generated stamp-able trait fields. These fields are generated by IT Collect to monitor who has created an individual record and when that record was created on IT Collect. Users are not able to overwrite these system generated fields. Please note the lastModified and lastModifiedBy fields fall under the same category.

Right now, there are no fields in the BY 2023 Submission Overviewhttps://itdashboard.gov/drupal/sites/itdb/files/BY_2023_IT_Collect_Submission_Overview.pdf that ask agencies to provide the PM or other agency user creates/manages an investment.

Best, Luke ITDB Support

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://hyperlink.services.treasury.gov/agency.do?origin=https://github.com/GSA/ITDB-schema/issues/459#issuecomment-907287181, or unsubscribehttps://hyperlink.services.treasury.gov/agency.do?origin=https://github.com/notifications/unsubscribe-auth/ALE6BHWEGXORIA6BCYSNQDTT66VPRANCNFSM5C3LUU6A. Triage notifications on the go with GitHub Mobile for iOShttps://hyperlink.services.treasury.gov/agency.do?origin=https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Androidhttps://hyperlink.services.treasury.gov/agency.do?origin=https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

KellyHarrisT commented 2 years ago

Anything to explain what each of the Schemas do and how they are used for Post/Patch/Get

Thanks

lschwenkebah commented 2 years ago

Hi Kelly,

The API schema outlines how you can interact with the IT Collect API. For each endpoint (Services, Projects, Ledgers, etc.), you will see the HTTP methods (POST, PUT, PATCH, GET, DELETE) you can use for that endpoint. Once you have selected an endpoint and method, the required/non-required fields and their descriptions and types will be listed. This is helpful to decide what you will need to include in the Request Body (JSON) when you process the request (i.e., interact with IT Collect). For further information on this, we suggest reading up on API schemas in general for a higher level understanding of their purpose; these concepts will apply to IT Collect's framework as well.

If you have any more questions on this, we would be happy to hop on a brief call to explain more. Thank you

Best, Luke

KellyHarrisT commented 2 years ago

Still interested in a response. If it would be easier, please set up a meeting. Thanks