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.

Sign up for GitHub

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

Jump to bottom

[CAT-803] Add dockerfile for container to generate docs #121

Merged
merged 3 commits into from
Oct 12, 2023
Merged

[CAT-803] Add dockerfile for container to generate docs #121

merged 3 commits into from
Oct 12, 2023

Conversation

meghanhickey
Copy link
Contributor

No description provided.

@meghanhickey meghanhickey marked this pull request as ready for review October 5, 2023 19:58
@github-actions
Copy link

github-actions bot commented Oct 5, 2023

Total Coverage: 32.16%

Coverage Report
FileBranchesFuncsLinesUncovered Lines
IndicoV2
   IndicoClient.cs100%100%100%
   IndicoClientExtensions.cs100%85.71%86.67%111, 94
IndicoV2.Abstractions/CommonModels/Pagination
   HasCursor.cs100%0%0%11, 9
   PageInfo.cs100%0%0%13, 17, 21, 25
IndicoV2.Abstractions/Extensions/SubmissionResult/Exceptions
   WrongSubmissionStatusException.cs100%33.33%33.33%11, 13
IndicoV2.Abstractions/Jobs/Exceptions
   JobNotSuccessfulException.cs100%33.33%33.33%11, 13
IndicoV2.Abstractions/Ocr/Models
   ExtractionJobResult.cs100%0%0%10
IndicoV2.Abstractions/Submissions/Models
   AndFilter.cs100%100%100%
   FilterConverter.cs0%0%0%16, 16, 16, 18, 18, 18, 19, 20, 21, 22, 23, 25, 25, 25, 27, 28, 29, 30, 33, 33, 33, 35, 36, 37, 38, 40
   OrFilter.cs100%100%100%
   SubmissionFilter.cs100%100%100%
   Submission.cs0%0%0%11, 12, 14, 16, 18, 20, 22, 24, 26, 26, 26, 28, 32, 32, 32, 34, 37
IndicoV2.Abstractions/Workflows/Models
   Workflow.cs100%0%0%10, 11, 12
IndicoV2.V1Adapters/CommonModels/Predictions
   Prediction.cs100%0%0%10, 13, 16, 19, 22
IndicoV2.V1Adapters/Converters
   CastingConverter.cs100%50%71.43%14, 9
   InterfaceConverter.cs100%100%100%
   SubmissionFilterConverters.cs83.33%100%94.44%31, 39
   SubmissionStatusConverters.cs66.67%100%75%17, 19, 27, 29
IndicoV2.V1Adapters/DataSets
   DataSetsV1ClientAdapter.cs0%33.33%2.63%21, 22, 23, 24, 25, 26, 27, 28, 30, 31, 32, 34, 35, 39, 39, 39, 43, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 63, 64, 65, 66, 68, 69
IndicoV2.V1Adapters/DataSets/Models
   V1DataSetAdapter.cs100%0%0%12, 9
   V1DataSetFullAdapter.cs100%0%0%12, 15, 18, 21
IndicoV2.V1Adapters/GraphQLRequest
   GraphQLRequestV1ClientAdapter.cs100%0%0%15, 17, 18, 22, 23, 24, 25, 26, 27
IndicoV2.V1Adapters/Jobs
   JobStatusConverter.cs100%100%100%
   V1JobsClientAdapter.cs0%20%11.43%25, 29, 30, 32, 33, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 52, 52, 52, 52, 54, 56, 56, 56, 58, 59, 61, 62, 63, 65, 66, 69
IndicoV2.V1Adapters/Models
   V1ModelClientAdapter.cs100%25%8.33%20, 21, 22, 23, 24, 28, 31, 32, 33, 34, 35
IndicoV2.V1Adapters/Models/Models
   PredictionJobResult.cs100%0%0%17, 19, 21, 23, 26
   V1ModelAdapter.cs100%100%100%
   V1ModelGroupAdapter.cs50%100%100%11
   V1ModelGroupBaseAdapter.cs100%100%100%
IndicoV2.V1Adapters/Ocr
   OcrV1ClientAdapter.cs100%25%19.05%28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 39, 40, 43, 47, 48, 50, 52
IndicoV2.V1Adapters/Reviews
   ReviewsV1ClientAdapter.cs100%50%10%18, 19, 20, 21, 22, 23, 24, 26, 27
IndicoV2.V1Adapters/Storage
   V1StorageClientAdapter.cs0%11.11%13.33%102, 102, 102, 104, 107, 109, 110, 111, 112, 114, 115, 116, 119, 120, 123, 124, 125, 126, 129, 130, 131, 133, 134, 33, 39, 40, 42, 43, 47, 49, 50, 54, 55, 57, 62, 63, 65, 71, 76, 77, 79, 81, 83, 84, 85, 86, 87, 89, 93, 94, 95, 96, 97, 99, 99, 99
IndicoV2.V1Adapters/Storage/Models
   FileMetadata.cs100%0%0%12, 15, 18, 9
IndicoV2.V1Adapters/Submissions
   SubmissionsV1ClientAdapter.cs0%12.50%3.13%24, 25, 27, 28, 32, 33, 35, 36, 40, 41, 43, 44, 49, 49, 49, 49, 49, 49, 49, 50, 51, 52, 53, 54, 55, 57, 59, 60, 64, 65, 66, 70, 72, 73, 77, 78, 79
IndicoV2.V1Adapters/Submissions/Models
   V1SubmissionAdapter.cs100%20%20%12, 16, 18, 20, 22, 24, 26, 28
IndicoV2/DataSets
   DataSetClient.cs100%14.29%33.33%26, 29, 34, 35, 36, 38, 39, 43, 46, 49
IndicoV2/Extensions/DataSets
   DataSetAwaiter.cs100%100%100%
IndicoV2/Extensions/JobResultBuilders
   JobResultBuilder.cs100%100%100%
IndicoV2/Extensions/JobResultBuilders/Submission
   UrlJobResult.cs100%100%100%
IndicoV2/Extensions/JobResultBuilders/Submission/Exceptions
   InvalidJobSubmissionResult.cs100%50%50%9
   InvalidUrlException.cs100%50%50%9
IndicoV2/Extensions/Jobs
   JobAwaiter.cs100%75%93.33%32
IndicoV2/Extensions/SubmissionResult
   SubmissionResultAwaiter.cs100%100%100%
IndicoV2/Extensions/Workflows
   WorkflowAwaiter.cs0%50%25%17, 17, 17, 19, 21
IndicoV2/GraphQLRequest
   GraphQLRequestClient.cs0%0%0%17, 19, 20, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 25
IndicoV2/Submissions
   SubmissionsClient.cs0%8.33%12.50%100, 102, 104, 31, 35, 36, 36, 36, 37, 43, 47, 51, 52, 52, 52, 54, 54, 54, 56, 57, 61, 65, 70, 75, 75, 75, 77, 78, 79, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 97
IndicoV2/Workflows
   WorkflowsClient.cs100%16.67%23.53%23, 24, 25, 29, 30, 31, 34, 37, 39, 40, 41, 42, 43

@meghanhickey
Copy link
Contributor Author

here's the generated markdown

@github-actions
Copy link

github-actions bot commented Oct 6, 2023

Total Coverage: 32.16%

Coverage Report
FileBranchesFuncsLinesUncovered Lines
IndicoV2
   IndicoClient.cs100%100%100%
   IndicoClientExtensions.cs100%85.71%86.67%111, 94
IndicoV2.Abstractions/CommonModels/Pagination
   HasCursor.cs100%0%0%11, 9
   PageInfo.cs100%0%0%13, 17, 21, 25
IndicoV2.Abstractions/Extensions/SubmissionResult/Exceptions
   WrongSubmissionStatusException.cs100%33.33%33.33%11, 13
IndicoV2.Abstractions/Jobs/Exceptions
   JobNotSuccessfulException.cs100%33.33%33.33%11, 13
IndicoV2.Abstractions/Ocr/Models
   ExtractionJobResult.cs100%0%0%10
IndicoV2.Abstractions/Submissions/Models
   AndFilter.cs100%100%100%
   FilterConverter.cs0%0%0%16, 16, 16, 18, 18, 18, 19, 20, 21, 22, 23, 25, 25, 25, 27, 28, 29, 30, 33, 33, 33, 35, 36, 37, 38, 40
   OrFilter.cs100%100%100%
   SubmissionFilter.cs100%100%100%
   Submission.cs0%0%0%11, 12, 14, 16, 18, 20, 22, 24, 26, 26, 26, 28, 32, 32, 32, 34, 37
IndicoV2.Abstractions/Workflows/Models
   Workflow.cs100%0%0%10, 11, 12
IndicoV2.V1Adapters/CommonModels/Predictions
   Prediction.cs100%0%0%10, 13, 16, 19, 22
IndicoV2.V1Adapters/Converters
   CastingConverter.cs100%50%71.43%14, 9
   InterfaceConverter.cs100%100%100%
   SubmissionFilterConverters.cs83.33%100%94.44%31, 39
   SubmissionStatusConverters.cs66.67%100%75%17, 19, 27, 29
IndicoV2.V1Adapters/DataSets
   DataSetsV1ClientAdapter.cs0%33.33%2.63%21, 22, 23, 24, 25, 26, 27, 28, 30, 31, 32, 34, 35, 39, 39, 39, 43, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 63, 64, 65, 66, 68, 69
IndicoV2.V1Adapters/DataSets/Models
   V1DataSetAdapter.cs100%0%0%12, 9
   V1DataSetFullAdapter.cs100%0%0%12, 15, 18, 21
IndicoV2.V1Adapters/GraphQLRequest
   GraphQLRequestV1ClientAdapter.cs100%0%0%15, 17, 18, 22, 23, 24, 25, 26, 27
IndicoV2.V1Adapters/Jobs
   JobStatusConverter.cs100%100%100%
   V1JobsClientAdapter.cs0%20%11.43%25, 29, 30, 32, 33, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 52, 52, 52, 52, 54, 56, 56, 56, 58, 59, 61, 62, 63, 65, 66, 69
IndicoV2.V1Adapters/Models
   V1ModelClientAdapter.cs100%25%8.33%20, 21, 22, 23, 24, 28, 31, 32, 33, 34, 35
IndicoV2.V1Adapters/Models/Models
   PredictionJobResult.cs100%0%0%17, 19, 21, 23, 26
   V1ModelAdapter.cs100%100%100%
   V1ModelGroupAdapter.cs50%100%100%11
   V1ModelGroupBaseAdapter.cs100%100%100%
IndicoV2.V1Adapters/Ocr
   OcrV1ClientAdapter.cs100%25%19.05%28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 39, 40, 43, 47, 48, 50, 52
IndicoV2.V1Adapters/Reviews
   ReviewsV1ClientAdapter.cs100%50%10%18, 19, 20, 21, 22, 23, 24, 26, 27
IndicoV2.V1Adapters/Storage
   V1StorageClientAdapter.cs0%11.11%13.33%102, 102, 102, 104, 107, 109, 110, 111, 112, 114, 115, 116, 119, 120, 123, 124, 125, 126, 129, 130, 131, 133, 134, 33, 39, 40, 42, 43, 47, 49, 50, 54, 55, 57, 62, 63, 65, 71, 76, 77, 79, 81, 83, 84, 85, 86, 87, 89, 93, 94, 95, 96, 97, 99, 99, 99
IndicoV2.V1Adapters/Storage/Models
   FileMetadata.cs100%0%0%12, 15, 18, 9
IndicoV2.V1Adapters/Submissions
   SubmissionsV1ClientAdapter.cs0%12.50%3.13%24, 25, 27, 28, 32, 33, 35, 36, 40, 41, 43, 44, 49, 49, 49, 49, 49, 49, 49, 50, 51, 52, 53, 54, 55, 57, 59, 60, 64, 65, 66, 70, 72, 73, 77, 78, 79
IndicoV2.V1Adapters/Submissions/Models
   V1SubmissionAdapter.cs100%20%20%12, 16, 18, 20, 22, 24, 26, 28
IndicoV2/DataSets
   DataSetClient.cs100%14.29%33.33%26, 29, 34, 35, 36, 38, 39, 43, 46, 49
IndicoV2/Extensions/DataSets
   DataSetAwaiter.cs100%100%100%
IndicoV2/Extensions/JobResultBuilders
   JobResultBuilder.cs100%100%100%
IndicoV2/Extensions/JobResultBuilders/Submission
   UrlJobResult.cs100%100%100%
IndicoV2/Extensions/JobResultBuilders/Submission/Exceptions
   InvalidJobSubmissionResult.cs100%50%50%9
   InvalidUrlException.cs100%50%50%9
IndicoV2/Extensions/Jobs
   JobAwaiter.cs100%75%93.33%32
IndicoV2/Extensions/SubmissionResult
   SubmissionResultAwaiter.cs100%100%100%
IndicoV2/Extensions/Workflows
   WorkflowAwaiter.cs0%50%25%17, 17, 17, 19, 21
IndicoV2/GraphQLRequest
   GraphQLRequestClient.cs0%0%0%17, 19, 20, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 25
IndicoV2/Submissions
   SubmissionsClient.cs0%8.33%12.50%100, 102, 104, 31, 35, 36, 36, 36, 37, 43, 47, 51, 52, 52, 52, 54, 54, 54, 56, 57, 61, 65, 70, 75, 75, 75, 77, 78, 79, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 97
IndicoV2/Workflows
   WorkflowsClient.cs100%16.67%23.53%23, 24, 25, 29, 30, 31, 34, 37, 39, 40, 41, 42, 43

@goatrocks
Copy link
Contributor

We'll probably want to find a way to exclude the generated code from the markdown files

@github-actions
Copy link

Total Coverage: 32.16%

Coverage Report
FileBranchesFuncsLinesUncovered Lines
IndicoV2
   IndicoClient.cs100%100%100%
   IndicoClientExtensions.cs100%85.71%86.67%111, 94
IndicoV2.Abstractions/CommonModels/Pagination
   HasCursor.cs100%0%0%11, 9
   PageInfo.cs100%0%0%13, 17, 21, 25
IndicoV2.Abstractions/Extensions/SubmissionResult/Exceptions
   WrongSubmissionStatusException.cs100%33.33%33.33%11, 13
IndicoV2.Abstractions/Jobs/Exceptions
   JobNotSuccessfulException.cs100%33.33%33.33%11, 13
IndicoV2.Abstractions/Ocr/Models
   ExtractionJobResult.cs100%0%0%10
IndicoV2.Abstractions/Submissions/Models
   AndFilter.cs100%100%100%
   FilterConverter.cs0%0%0%16, 16, 16, 18, 18, 18, 19, 20, 21, 22, 23, 25, 25, 25, 27, 28, 29, 30, 33, 33, 33, 35, 36, 37, 38, 40
   OrFilter.cs100%100%100%
   SubmissionFilter.cs100%100%100%
   Submission.cs0%0%0%11, 12, 14, 16, 18, 20, 22, 24, 26, 26, 26, 28, 32, 32, 32, 34, 37
IndicoV2.Abstractions/Workflows/Models
   Workflow.cs100%0%0%10, 11, 12
IndicoV2.V1Adapters/CommonModels/Predictions
   Prediction.cs100%0%0%10, 13, 16, 19, 22
IndicoV2.V1Adapters/Converters
   CastingConverter.cs100%50%71.43%14, 9
   InterfaceConverter.cs100%100%100%
   SubmissionFilterConverters.cs83.33%100%94.44%31, 39
   SubmissionStatusConverters.cs66.67%100%75%17, 19, 27, 29
IndicoV2.V1Adapters/DataSets
   DataSetsV1ClientAdapter.cs0%33.33%2.63%21, 22, 23, 24, 25, 26, 27, 28, 30, 31, 32, 34, 35, 39, 39, 39, 43, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 63, 64, 65, 66, 68, 69
IndicoV2.V1Adapters/DataSets/Models
   V1DataSetAdapter.cs100%0%0%12, 9
   V1DataSetFullAdapter.cs100%0%0%12, 15, 18, 21
IndicoV2.V1Adapters/GraphQLRequest
   GraphQLRequestV1ClientAdapter.cs100%0%0%15, 17, 18, 22, 23, 24, 25, 26, 27
IndicoV2.V1Adapters/Jobs
   JobStatusConverter.cs100%100%100%
   V1JobsClientAdapter.cs0%20%11.43%25, 29, 30, 32, 33, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 52, 52, 52, 52, 54, 56, 56, 56, 58, 59, 61, 62, 63, 65, 66, 69
IndicoV2.V1Adapters/Models
   V1ModelClientAdapter.cs100%25%8.33%20, 21, 22, 23, 24, 28, 31, 32, 33, 34, 35
IndicoV2.V1Adapters/Models/Models
   PredictionJobResult.cs100%0%0%17, 19, 21, 23, 26
   V1ModelAdapter.cs100%100%100%
   V1ModelGroupAdapter.cs50%100%100%11
   V1ModelGroupBaseAdapter.cs100%100%100%
IndicoV2.V1Adapters/Ocr
   OcrV1ClientAdapter.cs100%25%19.05%28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 39, 40, 43, 47, 48, 50, 52
IndicoV2.V1Adapters/Reviews
   ReviewsV1ClientAdapter.cs100%50%10%18, 19, 20, 21, 22, 23, 24, 26, 27
IndicoV2.V1Adapters/Storage
   V1StorageClientAdapter.cs0%11.11%13.33%102, 102, 102, 104, 107, 109, 110, 111, 112, 114, 115, 116, 119, 120, 123, 124, 125, 126, 129, 130, 131, 133, 134, 33, 39, 40, 42, 43, 47, 49, 50, 54, 55, 57, 62, 63, 65, 71, 76, 77, 79, 81, 83, 84, 85, 86, 87, 89, 93, 94, 95, 96, 97, 99, 99, 99
IndicoV2.V1Adapters/Storage/Models
   FileMetadata.cs100%0%0%12, 15, 18, 9
IndicoV2.V1Adapters/Submissions
   SubmissionsV1ClientAdapter.cs0%12.50%3.13%24, 25, 27, 28, 32, 33, 35, 36, 40, 41, 43, 44, 49, 49, 49, 49, 49, 49, 49, 50, 51, 52, 53, 54, 55, 57, 59, 60, 64, 65, 66, 70, 72, 73, 77, 78, 79
IndicoV2.V1Adapters/Submissions/Models
   V1SubmissionAdapter.cs100%20%20%12, 16, 18, 20, 22, 24, 26, 28
IndicoV2/DataSets
   DataSetClient.cs100%14.29%33.33%26, 29, 34, 35, 36, 38, 39, 43, 46, 49
IndicoV2/Extensions/DataSets
   DataSetAwaiter.cs100%100%100%
IndicoV2/Extensions/JobResultBuilders
   JobResultBuilder.cs100%100%100%
IndicoV2/Extensions/JobResultBuilders/Submission
   UrlJobResult.cs100%100%100%
IndicoV2/Extensions/JobResultBuilders/Submission/Exceptions
   InvalidJobSubmissionResult.cs100%50%50%9
   InvalidUrlException.cs100%50%50%9
IndicoV2/Extensions/Jobs
   JobAwaiter.cs100%75%93.33%32
IndicoV2/Extensions/SubmissionResult
   SubmissionResultAwaiter.cs100%100%100%
IndicoV2/Extensions/Workflows
   WorkflowAwaiter.cs0%50%25%17, 17, 17, 19, 21
IndicoV2/GraphQLRequest
   GraphQLRequestClient.cs0%0%0%17, 19, 20, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 25
IndicoV2/Submissions
   SubmissionsClient.cs0%8.33%12.50%100, 102, 104, 31, 35, 36, 36, 36, 37, 43, 47, 51, 52, 52, 52, 54, 54, 54, 56, 57, 61, 65, 70, 75, 75, 75, 77, 78, 79, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 97
IndicoV2/Workflows
   WorkflowsClient.cs100%16.67%23.53%23, 24, 25, 29, 30, 31, 34, 37, 39, 40, 41, 42, 43

@meghanhickey
Copy link
Contributor Author

updated docs: https://drive.google.com/file/d/1dfgo8402WNi5HzppPOyimNjCPc5MlbnV/view?usp=sharing

@meghanhickey meghanhickey merged commit 1ab5a22 into master Oct 12, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@goatrocks goatrocks goatrocks approved these changes

@fitzworkhub fitzworkhub Awaiting requested review from fitzworkhub

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@meghanhickey @goatrocks