Skip to content

DOCS: Fix CAA_BUILDER parameter types (issuewild type should be string[])#2709

Merged
tlimoncelli merged 1 commit intoStackExchange:masterfrom
marte26:master
Dec 11, 2023
Merged

DOCS: Fix CAA_BUILDER parameter types (issuewild type should be string[])#2709
tlimoncelli merged 1 commit intoStackExchange:masterfrom
marte26:master

Conversation

@marte26
Copy link
Copy Markdown
Contributor

@marte26 marte26 commented Dec 10, 2023

The typescript definition file uses the string type for issuewild in CAA_BUILDER, but it should be string[] as noted in the documentation

@cafferata
Copy link
Copy Markdown
Collaborator

cafferata commented Dec 10, 2023

Hey @marte26!

I see that this is your first PR. That is great! Welcome!

Some additional context: the file types-dnscontrol.d.ts is generated by the Go command below.

go generate ./...

This means that you (also) need to adjust this change in the source file documentation/functions/domain/CAA_BUILDER.md:

parameter_types:
  label: string?
  iodef: string
  iodef_critical: boolean?
  issue: string[]
- issuewild: string
+ issuewild: string[]

https://github.com/StackExchange/dnscontrol/blob/7e79713/documentation/functions/domain/CAA_BUILDER.md?plain=1#L15

Cheers!

@tlimoncelli
Copy link
Copy Markdown
Contributor

I'll take care of go generate in a separate PR

@tlimoncelli tlimoncelli changed the title Change issuewild type from string to string[] DOCS: Fix CAA_BUILDER parameter types (issuewild type should be string[]) Dec 11, 2023
@tlimoncelli tlimoncelli merged commit 724ce29 into StackExchange:master Dec 11, 2023
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.

3 participants